<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="CouchResponder,pl.vane.as3relax.CouchResponder,action,fault,result" name="keywords">
<title>pl.vane.as3relax.CouchResponder</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'CouchResponder - AS3Relax Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">AS3Relax Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?pl/vane/as3relax/CouchResponder.html&amp;pl/vane/as3relax/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;CouchResponder</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class CouchResponder"); titleBar_setSubNav(false,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">pl.vane.as3relax</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CouchResponder</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CouchResponder <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="ICouchResponder.html">ICouchResponder</a>, <a href="../net/services/IURLResponder.html">IURLResponder</a></td>
</tr>
</table>
<p></p>
  CouchResponder Class handles response from the CouchDB API
  
  <p>CouchResponder implements IURLResponder interface to comunicate with
  the CouchDB and dispatch CouchEvent to send the response to your application</p>
  
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../net/services/IURLResponder.html" target="">pl.vane.net.services.IURLResponder</a>
<br>
<a href="../as3relax/ICouchResponder.html" target="">pl.vane.as3relax.ICouchResponder</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#action">action</a> : String<div class="summaryTableDescription">[read-only]
   Returns action performed by the request to the CouchDB API.</div>
</td><td class="summaryTableOwnerCol">CouchResponder</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#CouchResponder()">CouchResponder</a>(action:String = null)</div>
<div class="summaryTableDescription">
   Constructor.</div>
</td><td class="summaryTableOwnerCol">CouchResponder</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#fault()">fault</a>(fault:Array):void</div>
<div class="summaryTableDescription">
   Dispatch fault <code>Array</code> response from the CouchDB API.</div>
</td><td class="summaryTableOwnerCol">CouchResponder</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#result()">result</a>(result:*):void</div>
<div class="summaryTableDescription">
   Dispatch event with response from the CouchDB API and sends 
   the response data in the <code>event.data</code> property.</div>
</td><td class="summaryTableOwnerCol">CouchResponder</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:couchevent.data">couchevent.data</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
   Dispatched when data is returned from the CouchDB API,
  
   </td><td class="summaryTableOwnerCol">CouchResponder</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:couchevent.fault">couchevent.fault</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
   Dispatched when errors ocures when performing action to the CouchDB API
  
   </td><td class="summaryTableOwnerCol">CouchResponder</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="action"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">action</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>action:String</code>&nbsp;&nbsp;[read-only]<p>
   Returns action performed by the request to the CouchDB API.
   
   </p><p>You can get the action that this responder handle</p>
   
   <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get action():String</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../as3relax/CouchEventAction.html" target="">pl.vane.as3relax.CouchEventAction</a>
</div>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="CouchResponder()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CouchResponder</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function CouchResponder(action:String = null)</code><p>
   Constructor.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">action</span>:String</code> (default = <code>null</code>)<code></code></td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="fault()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fault</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function fault(fault:Array):void</code><p>
   Dispatch fault <code>Array</code> response from the CouchDB API.
   the <code>Array</code> has four values:
   <ul> 
   <li> [1] The full url of the request</li>
   <li> [2] The event.text that caused the error with error number and description</li>
   <li> [3] The event.type (ioError, securityError) </li>
   <li> [4] The the HttpResponseStatus Text </li>
   </ul>
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">fault</span>:Array</code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../net/services/URLLoaderBase.html" target="">pl.vane.net.services.URLLoaderBase</a>
<br>
<a href="../net/services/IURLResponder.html" target="">pl.vane.net.services.IURLResponder</a>
</div>
</div>
<a name="result()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">result</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function result(result:*):void</code><p>
   Dispatch event with response from the CouchDB API and sends 
   the response data in the <code>event.data</code> property.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">result</span>:*</code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../net/services/URLLoaderBase.html" target="">pl.vane.net.services.URLLoaderBase</a>
<br>
<a href="../net/services/IURLResponder.html" target="">pl.vane.net.services.IURLResponder</a>
</div>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:couchevent.data"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">couchevent.data</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../as3relax/CouchEvent.html"><code>pl.vane.as3relax.CouchEvent</code></a>
<br>
<span class="label">CouchEvent.type property = </span><a href="../as3relax/CouchEvent.html#DATA"><code>pl.vane.as3relax.CouchEvent.DATA</code></a>
<br><p>
   Dispatched when data is returned from the CouchDB API,
  
   </p><p>
   The <code>CouchEvent.DATA</code> constant defines the value of the
   <code>type</code> property of the event object for an <code>couchevent.data</code> event.
      </p><p>The action property of the event object have the following values:</p>
   <table class="innertable">
      <tr><th>Property</th><th>Value</th></tr>
      <tr><td><code>action</code></td><td>changes | compact | delete | get | post  | put | replicate | uuid</td></tr>
   </table>
      </div>
<a name="event:couchevent.fault"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">couchevent.fault</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../as3relax/CouchEvent.html"><code>pl.vane.as3relax.CouchEvent</code></a>
<br>
<span class="label">CouchEvent.type property = </span><a href="../as3relax/CouchEvent.html#FAULT"><code>pl.vane.as3relax.CouchEvent.FAULT</code></a>
<br><p>
   Dispatched when errors ocures when performing action to the CouchDB API
  
   </p><p>
   The <code>CouchEvent.DATA</code> constant defines the value of the
   <code>type</code> property of the event object for an <code>couchevent.fault</code> event.
      </p><p>The action property of the event object have the following values:</p>
   <table class="innertable">
      <table class="innertable">
      <tr><th>Property</th><th>Value</th></tr>
      <tr><td><code>action</code></td><td>changes | compact | delete | get | post  | put | replicate | uuid</td></tr>
   </table>
      </div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">http://code.google.com/p/as3relax/ | http://vane.pl</center>
</div>
</body>
</html>
<!--http://code.google.com/p/as3relax/ | http://vane.pl-->
